home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / hsa15.zip / HSA.DOC < prev    next >
Text File  |  1993-04-07  |  23KB  |  483 lines
  1.          ┌▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄┐
  2.          ├▌▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐┤
  3.  ────────┤▌ G  A  M  E  K  E  E  P  E  R    D  O  O  R  W  A  R  E ▐├────────
  4.          ├▌▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐┤
  5.          ├▌▒▒▒▒▒▒▒▒▒  Quality BBS Door Software for Less!  ▒▒▒▒▒▒▒▒▐┤
  6.          ├▌▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐┤
  7.          └▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┘
  8.  
  9.                         H I G H   S E A S   A R M A D A
  10.                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  11.                                  Version 1.5
  12.  
  13.                      Copyright (c) Steve Sharpe 1992,1993
  14.  
  15. SYSTEM REQUIREMENTS
  16. ~~~~~~~~~~~~~~~~~~~
  17. 1.  Any BBS capable of producing the following DOOR.SYS drop files:
  18.  
  19.    *  Original "GAP standard" DOOR.SYS (31 line version)
  20.         - for example, Spitfire BBSs use this one!
  21.  
  22.    *  New (currently 52 line) version DOOR.SYS promoted by Raymond Clements
  23.         - for example, PCBoard BBSs use this one!
  24.  
  25. 2.  High Seas Armada requires ANSI graphics!
  26.  
  27. Note:  If you use door management programs that control the amount of time a
  28. user can spend in a door (like Wildfire, etc.), ensure the door that High Seas
  29. Armada is placed in is set for more than 30 minutes of access time.  This is
  30. extremely important since High Seas Armada saves critical game information at
  31. the end of each play session.
  32.  
  33. SYSTEM OPTIONS
  34. ~~~~~~~~~~~~~~
  35. High Seas Armada supports the use of FOSSIL drivers and non-standard port
  36. addresses.  Refer to the INSTALLATION instructions for more information.
  37.  
  38. FILES CONTAINED IN HSA15.ZIP
  39. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  40.      HSA15.EXE       <-- The main program
  41.      HSA1.MAP        <-- Section 1 of the kingdom map
  42.      HSA2.MAP        <-- Section 2 of the kingdom map
  43.      HSA3.MAP        <-- Section 3 of the kingdom map
  44.      HSA4.MAP        <-- Section 4 of the kingdom map
  45.      HSA.DOC         <-- The file you are reading!
  46.      HSACONFG.EXE    <-- The multi-purpose door configuration program
  47.      DOORWARE.DOC    <-- Gamekeeper Doorware list
  48.      REVISION.DOC    <-- Revision notes
  49.  
  50. FILES CREATED BY HSACONFG.EXE
  51. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  52.      GAME.CFG        <-- Game configuration file
  53.      SCORE.FIL       <-- Score data for internal use by HSA15.EXE
  54.      PLAYER_?.DAT    <-- Player data files where ? represents the kingdom
  55.                          number
  56.      HIDDEN.DAT      <-- Treasure and trap data file
  57.      LEDGER.DAT      <-- File containing number of coins given to each king
  58.      STATUS.DAT      <-- Miscellaneous game status file
  59.      SHIPS.DAT       <-- Galleon data file
  60.      BULLETIN.TXT    <-- Armada Activity Log text (This file is not updated in
  61.                          unregistered versions)
  62.  
  63. OVERVIEW
  64. ~~~~~~~~
  65. Number of Players: 1-8
  66.  
  67. High Seas Armada is a scavenger hunt door where players search for buried
  68. treasure (gold coins).  These coins can be found throughout the land and on
  69. the islands that are located in the Mystic Ocean.  Players work for the king
  70. of their kingdom in an effort to return as many gold coins to their king as
  71. possible.  The player who returns the most gold coins, after the last one is
  72. discovered, is the winner.  Pirates, from years gone by, have placed traps to
  73. protect these buried treasures.  These traps can injure your crew which reduces
  74. the amount of gold they can carry!  Port cities are located at strategic points
  75. and offer services (for a fee) to heal injuries, repair damaged galleons, etc.
  76. In order to get to the islands, you must sail a galleon that has been provided
  77. to you by your king.  Winds on the Mystic Ocean change periodically which 
  78. affect the way your galleon reacts to steering commands!  If you crash your
  79. galleon, you will die.  This doesn't help you king achieve his goals!  You will
  80. receive 1000 additional coins each day.  These coins are deposited to an
  81. account the king has set up for you.  You'll need them to pay for services
  82. in the port cities.  In return for your loyalty, the king will give you 20%
  83. of the coins you return to him!
  84.  
  85. GAME OPTIONS
  86. ~~~~~~~~~~~~
  87. Map display
  88. ~~~~~~~~~~~
  89. Your present position is always reflected at the center of the map display,
  90. located in the lower left corner of the screen.  Exact North/South and East/
  91. West coordinates are provided for reference.  A map key defines the various
  92. symbols that appear on the map.
  93.  
  94. Navigating the Mystic Ocean
  95. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  96. You begin the game on board your galleon which is moored to your home port.
  97. The galleon is equipped with a large main sail, an anchor, and a 3 position
  98. rudder.  To set sail, first raise the anchor.  Then position the rudder in
  99. the direction you want the bow to turn.  Finally, raise the sail and enjoy
  100. the ride!  Watch the heading.  In calm winds, the heading will change by 45
  101. degrees with left or right rudder.  Straighten the rudder when you wish to
  102. maintain a particular heading.  Speed is a function of winds and cannot be
  103. manually changed.  Watch out for coral reefs.  If you hit them, your galleon
  104. will be damaged!  Periodically, the winds will shift.  If you encounter a
  105. head or tail wind, steering remains the same but your speed will decrease or
  106. increase, respectively.  However, if you encounter a crosswind, normal
  107. steering will be impossible.  You will have to keep the rudder turned left or
  108. right just to sail straight!  Turns can only be made with the wind, not into
  109. it.  If you get into a tight situation, you may have to stop the galleon
  110. until the winds change!  To stop the galleon, just lower the sail!
  111.  
  112. GAME NOTE:  Occasionally, particularly after traveling on land or an island,
  113. there will be a short delay before the galleon begins to move when the sails
  114. are raised.  This is normal.  Be patient!  You will see the speed increase
  115. before too long.
  116.  
  117. Moving about on land
  118. ~~~~~~~~~~~~~~~~~~~~
  119. Use the numeric keypad (ensure the NUM LOCK key is on) or the number keys to
  120. move on land or islands.  Be careful, though.  You don't know how to swim!
  121. Port cities offer services for the needy adventurer if you have enough money
  122. in your account.
  123.  
  124. Digging
  125. ~~~~~~~
  126. You have to dig on land and on islands to discover buried gold coins.  Keep
  127. track of where you have dug!  There's a lot of ground to cover and you won't
  128. want to waste time digging in unproductive places.  You may not be able to
  129. carry all the coins you find at one time.  A healthy crew can carry 4000
  130. coins and an undamaged galleon can hold 8000 coins.
  131.  
  132. Boarding enemy galleons
  133. ~~~~~~~~~~~~~~~~~~~~~~~
  134. You can board enemy galleons to steal the coins in their hold, subject to the
  135. coin carrying limitations described above.  In order for your crew to board
  136. the other vessel, you must position your own galleon so that the enemy is
  137. directly north or south of your galleon.  Anytime you encounter another
  138. galleon, you should board it and steal coins to prevent the enemy from
  139. increasing their wealth!  Of course, they'll be looking to do the same thing
  140. to you!  Try to spend the night in a protected harbor that is difficult for
  141. others to access.
  142.  
  143. Read ledger
  144. ~~~~~~~~~~~
  145. The ledger tells you the balance of gold coins returned to each king as of
  146. the time the previous player exited the game.
  147.  
  148. Medical doctor
  149. ~~~~~~~~~~~~~~
  150. Visit the doctor to heal crew member injuries.
  151.  
  152. Galleon repairs
  153. ~~~~~~~~~~~~~~~
  154. Visit the local shipbuilder to have galleon damage repaired.
  155.  
  156. The soothsayer
  157. ~~~~~~~~~~~~~~
  158. The soothsayer has magical powers.  You can visit her to learn where buried
  159. treasure can be found, but it can be expensive.  She requires you to pay her
  160. 25% of the amount of gold you find and she expects to take it out of your
  161. kingdom account at the time of discovery!  If you can't meet her terms,
  162. she'll place a curse on your crew members that can severely hamper your
  163. treasure-finding efforts!  It is said a cure for the curse exists somewhere!
  164.  
  165. DEATH!
  166. ~~~~~~
  167. If you get killed, you will lose any gold you are carrying.  Your king takes
  168. 1/2 the gold in your account to train "a new adventurer!"  The next time you
  169. log on, you will begin play at your kingdom port.
  170.  
  171. Screen Redraw
  172. ~~~~~~~~~~~~~
  173. A screen redraw feature can be activated while traveling on foot or when your
  174. galleon is not moving.  Use this feature if telephone line noise causes
  175. erroneous characters to be displayed.
  176.  
  177. INSTALLATION
  178. ~~~~~~~~~~~~
  179. Note:  Beginning with High Seas Armada 1.3, a different version of the
  180. STATUS.DAT file is used.  If you have a previous version of High Seas Armada
  181. installed,  you must delete the following files from your High Seas Armada
  182. directory before proceeding (games in progress will be reset!):
  183.  
  184.       GAME.CFG
  185.       STATUS.DAT
  186.       The old HSA??.EXE file (i.e. HSA10.EXE or HSA11.EXE)
  187.       The old EVENT??.EXE file (i.e. EVENT10.EXE or EVENT11.EXE)
  188.  
  189. High Seas Armada is easy to install.  Simply follow these steps:
  190.  
  191. 1.  'Unzip' the file HSA15.ZIP into the directory of your choice.  All
  192. files must remain in the same directory.
  193.  
  194. 2.  Run HSACONFG SETUP from the High Seas Armada directory (refer to
  195. HSACONFG.EXE USE later in this documentation) and enter setup data.  Game data
  196. files will be created.  High Seas Armada will be set to the automatic sign-up
  197. mode.
  198.  
  199. 3.  Create or edit the batch file your BBS will use to activate the door.
  200. The main door program name is HSA15.EXE.  For example, if you are running
  201. a Spitfire BBS, you would edit SF.BAT to look similar to the following:
  202.  
  203. :DOOR_A
  204.    REM Place Door A Commands Here
  205.    CD\SF\DOORS\HSA        <-- Change to the High Seas Armada directory
  206.    HSA15 GAME.CFG         <-- The main program with file argument
  207.    CD\SF                  <-- Change back to the Spitfire directory
  208.    GOTO LOOP
  209.  
  210. 4.  Create or edit the BBS file that controls event execution.  Include the
  211. command HSACONFG EVENT in the event batch file (refer to HSACONFG.EXE USE
  212. later in this documentation).  HSACONFG EVENT, the event function, must be run
  213. once each day for proper door operation.  The best time to run the event is
  214. just after midnight because the activity log is stamped with the date.  This
  215. allows the log to represent the correct day.  Don't forget to activate the
  216. event from within your BBS program!
  217.  
  218. Installation Notes
  219. ~~~~~~~~~~~~~~~~~~
  220. NON-STANDARD PORT USE:  You may specify the use of non-standard communications
  221. ports with the PORT command.  The syntax for the PORT command is PORT:03E8:5,
  222. where 03E8 represents a different base address and 5 indicates the IRQ.  For
  223. example, the main program line in the example above would be changed to
  224. HSA15 GAME.CFG PORT:03E8:5 to reflect the use of a non-standard comm port.
  225.  
  226. FOSSIL DRIVER USE:  You may specify the use of a FOSSIL driver with the PORT
  227. command added to the main program command line.  The syntax for the PORT
  228. command is PORT:F:P, where F instructs the door to use a FOSSIL driver and P
  229. identifies the port.  For example, the main program line in the example above
  230. would be changed to HSA15 GAME.CFG PORT:F:1 if the SysOp wished to specify
  231. a FOSSIL driver on port 1.
  232.  
  233. NOTE:  The PORT command must be the third command in the main program command
  234. line, if used.  If not used, the door defaults to the use of the 4 standard
  235. communications ports (1-4) by reading the BBS file.
  236.  
  237. HSACONFG.EXE USE
  238. ~~~~~~~~~~~~~~~~
  239. HSACONFG.EXE is a multi-purpose program designed to facilitate the
  240. installation of High Seas Armada, modify program options, and maintain the
  241. game through a daily BBS event.  The program is activated using a command line
  242. argument to specify the function you wish the program to perform.  The command
  243. line arguments are SETUP and EVENT.  HSACONFG.EXE must be located in the same
  244. directory as the other High Seas Armada files.
  245.  
  246. The SETUP function
  247. ~~~~~~~~~~~~~~~~~~
  248. Command:  HSACONFG SETUP
  249.  
  250. Use:  Initial door setup; Modify door options; Manual game start & reset
  251.  
  252. To run the setup function, execute the command from the High Seas Armada
  253. directory.  You will be asked to enter the following information:
  254.  
  255.       DOOR.SYS PATH/FILENAME:  Enter the complete path and filename for the
  256.       door.sys drop file. (Example: c:\sf\door.sys)
  257.  
  258.       BBS NAME:  Self-explanatory (see registration note below).
  259.  
  260.       SYSOP NAME:  Self-explanatory (see registration note below).
  261.  
  262.       REGISTRATION NUMBER:  If the door is unregistered, enter 12 zeros.  The
  263.       data block should be completely filled.  When you register the door, the
  264.       author will provide you with a unique registration number.  The
  265.       registration number may not necessarily fill the entire data block.
  266.  
  267.       DOOR.SYS VERSION:  Enter 1 if the DOOR.SYS drop file your BBS uses is the
  268.       original 31 line GAP standard (for example, Spitfire BBSs use this one).
  269.       Enter 2 if the DOOR.SYS drop file your BBS uses is the newer 52 line
  270.       version (for example, PCBoard BBSs use this one).
  271.  
  272. Registration Note:  The BBS and SysOp names must be entered exactly as they
  273. appeared on the door registration form.  Letter case is important!  An error
  274. in either of these blocks will prevent the door from running, even if you
  275. possess a valid registration number.
  276.  
  277. The entries above can be changed at any time, however, there should be no
  278. reason to change anything but the registration number after initial door
  279. configuration.
  280.  
  281.       OPERATING MODE - {0} Sign-up or {1} Play:  Enter 0 to put the door in
  282.       the sign-up mode.  Each new game must begin in this mode.  An error will
  283.       occur if you attempt to set the operating mode to play during initial
  284.       door configuration or when 0 players have signed up.
  285.  
  286.       Enter 1 to put the door in the play mode.  This option is only necessary
  287.       when you wish to manually start a game with less players than the
  288.       NUMBER OF PLAYERS option is currently set for.  When you manually start
  289.       a game, the number of players is automatically set to the number already
  290.       signed up.  The NUMBER OF PLAYERS option has no effect!  IMPORTANT:  If
  291.       you manually start a game, you must run HSACONFG EVENT one time,
  292.       manually, to set player accounts to 2000 gold coins, otherwise their
  293.       starting account balances will be 1000.
  294.  
  295.       Once the game is underway (in play mode), the game can be manually reset
  296.       by setting the operating mode to 0.  All game data files will be reset
  297.       and player information will be lost!  Make sure this is what you want to
  298.       do!
  299.  
  300.       ELAPSED DAYS WITHOUT PLAY BEFORE RESET:  This option is used to set the
  301.       number of days the event function will wait before completely resetting
  302.       the door due to inactivity on the part of all players.  Use a number from
  303.       1 to 99.  This option prevents the door from remaining in play mode
  304.       indefinitely.  It can be changed at any time.
  305.  
  306.       NUMBER OF PLAYERS:  Enter a number from 1 to 8.  This entry is used by
  307.       the event function to automatically begin the game after a certain 
  308.       number of players has signed up.  You can manually begin a game by 
  309.       following the procedures outlined in OPERATING MODE above or by lowering
  310.       the number in this block to equal the number of players currently
  311.       signed up (after initial game configuration).  Do not change this entry
  312.       after a game has begun or the door will automatically reset the data
  313.       files and enter the signup mode for a new game!
  314.  
  315. The EVENT function
  316. ~~~~~~~~~~~~~~~~~~
  317. Command:  HSACONFG EVENT
  318.  
  319. Use:  Perform daily game maintenance;
  320.  
  321. To run the event function, enter the command as part of your BBS event batch
  322. file and set the event to run daily.  The best time to run the event is just
  323. after midnight since the Armada activity log is stamped with the date and is
  324. supposed to reflect all game activity for that day.
  325.  
  326. Sample Spitfire BBS event batch file (within SF.BAT)
  327.  
  328. :EVENT_F
  329.    REM Place Event F Commands Here
  330.    CD\SF\DOORS\HSA
  331.    HSACONFG EVENT
  332.    CD\SF
  333.    GOTO LOOP
  334.  
  335. The event function will automatically start the game after the number of
  336. players, reflected in the setup function, have signed up.  It will also
  337. deposit gold coins to each player's account, generate/update the Armada 
  338. activity log, calculate the winner after the last coin is returned to a king,
  339. and reset the game after a winner is identified or a certain number of days
  340. has passed since any player has played the game.
  341.  
  342. OPERATION
  343. ~~~~~~~~~
  344. The game will allow a minimum of 1 player and a maximum of 8 players to play. 
  345. The door begins in a sign-up mode.  This mode continues until the number of
  346. players, identified while using the setup function, have signed-up.  At that
  347. time, the next execution of the event function, HSACONFG EVENT, will
  348. automatically begin the game.  If you wish to start the game manually, run
  349. HSACONFG SETUP and change the OPERATING MODE from 0 to 1 (assuming there is
  350. at least 1 player signed up).  The game will then be ready for play.
  351.  
  352. The door takes care of itself during game play, depositing coins to player
  353. accounts, tracking player movements, and monitoring recovered treasures.  The
  354. game ends when the event function runs after the last gold coin has been
  355. returned to a king.  The winner is determined and the game is automatically
  356. reset for a new game with different treasure and trap locations!
  357.  
  358. The event function also monitors how often each player participates in the
  359. game.  If no game activity takes place over a period of days specified in the
  360. setup function, the door is reset to allow new players to sign-up.  This
  361. monitoring period can be changed by the SysOp at any time by running
  362. HSACONFG SETUP.  This feature allows High Seas Armada to operate virtually
  363. transparent to the SysOp!
  364.  
  365. To manually reset the game at any time (which shouldn't be necessary), run
  366. HSACONFG SETUP and change the OPERATING MODE from 1 to 0.  You will be asked
  367. to confirm whether the game should be reset.  If you answer yes, all data files
  368. will be reset and the sign-up mode will be activated.
  369.  
  370. REGISTERED VERSIONS
  371. ~~~~~~~~~~~~~~~~~~~
  372. Registered versions of High Seas Armada offer the following features:
  373.  
  374.       *  Armada activity log is displayed before each game session
  375.            -  Identifies amount of coins remaining to be found
  376.            -  Tracks the last few days of all player key movements/status
  377.  
  378.       *  High score screen
  379.            -  Displays most gold ever given to a king
  380.            -  Displays previous game winner
  381.  
  382.       *  Unregistered screen displays are removed and replaced with the name
  383.          of your BBS
  384.  
  385. For registered users:  The SCORE.FIL is not affected during reset operations
  386. so that it can continue to track high scores.
  387.  
  388. REGISTRATION
  389. ~~~~~~~~~~~~
  390. The registration fee for High Seas Armada is $10.  The unregistered door
  391. displays "EVALUATION COPY" upon entry and exit.  Please register or remove the
  392. door within 90 days of first use.  As a BBS SysOp, I understand how costly it
  393. can be to register BBS software.  I have purposely kept the cost of registering
  394. High Seas Armada to a minimum with that thought in mind.  I believe the fee is
  395. quite reasonable, based on the many long hours of programming required.  Upon
  396. receipt of the registration fee, you will be provided with a unique
  397. registration number.  Once you insert the registration number into the GAME.CFG
  398. file, the opening and closing "EVALUATION COPY" messages will be replaced with
  399. the following messages:
  400.  
  401. [OPENING MESSAGE]
  402.  
  403.                                 Your BBS name
  404.  
  405.                                   presents
  406.  
  407. [CLOSING MESSAGE]
  408.  
  409.                              Thanks for playing
  410.  
  411.                               High Seas Armada
  412.  
  413.                                      on
  414.  
  415.                                Your BBS name
  416.  
  417. COMMENTS/BUG REPORTS
  418. ~~~~~~~~~~~~~~~~~~~~
  419. I'm interested in all user comments and bug reports.  Please send your comments
  420. to:
  421.  
  422.                               Steve Sharpe
  423.                            1835 Stonetree Dr.
  424.                          Mountain Home, ID 83647
  425.  
  426.                                  Warranty
  427.                                ------------
  428.        This program has been thoroughly tested on a Spitfire 3.3 BBS,
  429.        however, it should perform equally well on any BBS that can
  430.        produce a BBS drop file listed in this documentation.
  431.  
  432.        I make no warranty of any kind, express or implied, including
  433.        without limitation, any warranties of merchantability and/or
  434.        fitness for a particular purpose.  I shall not be held liable for
  435.        any  damages, whether direct, indirect, special or consequential
  436.        arising from a failure  of this program to operate in the manner
  437.        desired by the user.  I shall not be held liable for any damage to
  438.        data or property which may be caused directly or indirectly by the
  439.        use of this program.
  440.  
  441.        In no event will I be held liable for any damages, including (but
  442.        not limited to) any lost profits, lost savings or other incidental
  443.        or consequential damages arising out of the use or inability to
  444.        use this program, or for any claim by any other party.
  445.  
  446.        This warranty is governed by the laws of the State of Idaho.
  447.  
  448.  
  449.                               REGISTRATION FORM
  450.                               -----------------
  451.  
  452.   High Seas Armada                 Return to:  Steve Sharpe
  453.   Version 1.5                                  Attn: Door Registration
  454.   Registration Cost: $10                       1835 Stonetree Dr.
  455.                                                Mountain Home, ID 83647
  456.  
  457.   Name ______________________________________________________________
  458.  
  459.   Address ___________________________________________________________
  460.  
  461.           ___________________________________________________________
  462.  
  463.   Voice Phone _____________________ Data Phone ______________________
  464.  
  465.   Enter the information below exactly as it appears in HSACONFG SETUP:
  466.  
  467.   BBS Name______________________________________________
  468.  
  469.   SysOp Name____________________________________________
  470.  
  471.   Orders outside the USA add $2.00 . . . . . . . . . . . . _________
  472.  
  473.       Please find enclosed a check or money order for USA $_________
  474.   payable to Steve Sharpe.  This shows my support of Shareware products
  475.   and the Shareware concept.  It also shows my encouragement to help further
  476.   the development of BBS doors.
  477.  
  478.       I understand that High Seas Armada is provided as-is and no warranties of
  479.   any kind, expressed or otherwise, are included and that I am using it at my
  480.   own risk.
  481.  
  482.   Signed: _________________________________________  Date: _________
  483.